Help file!


 

This is only a help file like mirc.hlp helping you with mIRC Scripting Library.

 

Identifiers

$lib.version returns the actual mIRC Scripting Library version, recommended to use on on load event.

$_rnick(#channel) return a random nickname from #channel. E.g. //mode #PST +o $_rnick(#PST)

$_comchans(nick) return common chans between $me and some nick. 
 Usage: $comchans([,token to separate each channel in the results])
  E.g. $_comchans(CoolMaster,$chr(44)) and will return all common channels to
  CoolMaster with ","($chr(44)) delimeter, if delimeter is null the delimeter will be the space.

$_allnicks(#channel) return all nicks on #channel. 
 E.g. //echo -a $_allnicks(#PST)

$_caps(token) return number of Capital letters on token.
 Prop: percent
  $_caps(token,N).percent return the percentage of Capital letters on token,  
   if N is null the percentage will be rounded to 2 else to N.

$_bold(token) return number of bold codes on token.
 Also suport prop percent with N optional [$_bold(token,N).percent], see $_caps

$_colour(token) return number of colour codes on token.
 Also suport prop percent with N optional [$_colour(token,N).percent], see $_caps

$_underline(token) return number of underline codes on token.
 Also suport prop percent with N optional [$_underline(token,N).percent], see $_caps

$_reverse(token) return number of reverse codes on token.
 Also suport prop percent with N optional [$_reverse(token,N).percent], see $_caps

$_allcontrol(token) return number of all control codes (bold,underline,colours,reverse) on token.
 Also suport prop percent with N optional [$_allcontrol(token,N).percent], see $_caps

$_percent(M,total,N) return percentage of M. If N is null the percentage is rounded to 2 else to N.
   
$_encrypt(token) encrypt token with asc. 
 E.g. //echo -a $_encrypt(CoolMaster) and return ¶67¶111¶111¶108¶77¶97¶115¶116¶101¶114

$_decrypt(encrypted-token) decrypt token with chr, token need to be encrypted by $_encrypt
 E.g. //echo -a $_decrypt(¶67¶111¶111¶108¶77¶97¶115¶116¶101¶114) and return CoolMaster.

$_rot13(token) Encrypt a decrypted token and decrypt an encrypted token with rot13 mode.
 E.g. //echo -a $_rot13(CoolMaster) will return PbbyZnfgre and //echo -a $_rot13(PbbyZnfgre)
  will return CoolMaster

$_rot127(token) Encrypt a decrypted token and decrypt an encrypted token with rot127 mode.
 E.g. //echo -a $_rot127(CoolMaster) will return ÂîîëÌàòóäñ and //echo -a $_rot127(ÂîîëÌàòóäñ)
  will return CoolMaster

$_status(#channel,[pos|nick]) return number or position from a channel, pos|nick are optional
 if they are null will return total. Note: prop is needed.
 Prop:
  all all nicks E.g. $_status(#PST).all will return total number of nicks on #PST
  op op nicks E.g. $_status(#PST,1).op will return the first op on #PST
  voice voice nicks E.g. $_status(#PST,CoolMaster).voice will return the N position of CoolMaster
  half halfops nick E.g. $_status(#PST,5).half will return the 5 halfop nick on #PST
  Also suports: reg(regular), nomop(nom ops), nomvoice(nom voice) and nomhalf (nom halfops)

$_m(nick,#channel) return @ if nick is op on #channel or + if voice

$_isop(nick,#channel) return $true if nick is op on #channel

$_isvo(nick,#channel) return $true if nick is voice on #channel

$_isreg(nick,#channel) return $true if nick is a regular user on #channel

$_ison(nick,#channel) return $true if nick is on #channel

$_reversetext(text) return the in reverse mode.
 E.g. $_reversetext(CoolMaster) will return retsaMlooC

$_lame(text) return text with vogal letters on bold.

$_isnotify(nick) return $true if nick is on notify list.

$_islevel(mask,level) return $true if mask have userlist level.
 E.g. of autoop when he/she joins a channel, if they have level 30:
  on *:join:#:if ($_islevel($address($nick,5),30)) mode # +o $nick

$_ismode(mode) return $true if mode is in your usermode.
 E.g. alias wallops if ($_ismode(o)) raw -q wallops : $+ $1- | else echo -a You're not an IRCoperator

$_chanmode(#channel) return #channel modes.

$_ischanmode(mode,#channel) return $true if mode is in #channel modes.

$_topic(#channel) return #channel topic if exists otherwise return $null

$_remove(text,token,[C]) remove from text, if C is null the delimiter will be space else C.
 E.g. 
  $_remove(CoolMaster is the best,is) return CoolMaster the best
  $_remove(CoolMaster.is.the.best,is,46) return CoolMaster.the.best

$_replace(text,token,newtoken,[C]) replace from text token for newtoken, see $_remove for C.
 E.g. $_replace(CoolMaster is the best,best,da) return CoolMaster is da best

$_over(text,token,N,[C]) overwrites token to N position, see $_remove for C.
 E.g. $_over(CoolMaster is the best,is not,2) return CoolMaster is not the best

$_insert(text,token,N,[C]) insert token in N position of text, see $_remove for C.
 E.g. $_insert(CoolMaster is the best,not,3) return CoolMaster is not the best

$_findt(text,token,[C]) return the position of token on text, see $_remove for C.
 E.g. $_findt(CoolMaster is the best,the) return 3

$_deltext(text,token,[C]) delete token from text, see $_remove for C.
  E.g. $_deltext(CoolMaster is the best,best) return CoolMaster is the

$_crazytext(text) return text in capital and lower letters.
 E.g. $_crazytext(coolmaster is the best) will return CoOlMaStEr Is ThE bEsT

$_shownotify return all notify nicks.

$_size(file) return size in B, Kb and MB acording to the size of file.

$_iclones(#channel,nick) return clones of nick on #channel

$_scramble(text) scrambles text.

$_del(text,N,M) delete a substring in a string, working with the length 
 of chars to delete starting from the position given.
 Usage: $_del(string,position of the first char to delete,number of chars to delete)

$_dur(seconds) return the duration of the given time in seconds, 
 in the format: [days:hours:]<mins>:<secs>
  E.g. $_dur(3500) return 58:20 where 58 is minutes and 20 seconds

$_singlewd(token1,token2,tokenN) just connects all tokens.
 E.g. $_singlewd(CoolMaster,Is,The,Best) will return CoolMasterIsTheBest

$_mp3(file.mp3) return some mp3 props. all $mp3 identifier prop are present on this ident.
 Extension must be 'mp3' this is to prevent mIRC to stop a will when you do $mp3(file.wav) or
 other extension diferent of mp3. If prop is length the length in format of $_dur identifier, the
 length have a error of 1 second. The file will take $shortfn format.
  E.g. $_mp3(file.mp3).artist will return artist

$_mp3dur(file.mp3) just returns mp3 length of file is the same of prop length identifer on $_mp3

$_ial(#channel) return $true if ial on channel is uptaded.

$_ibl(#channel) return $true if you allready seen the ban's on #channel command /mode #channel +b


Aliases

Note: <needed> [optional]



/_mode <#channel> <parammeters> Just send a raw command to server to change channel mode.

/_op <#channel> <nick1> [nick2,nickN..,nick25] Op nick(s) on channel.

/_dop <#channel> <nick1> [nick2,nickN..,nick25] Dop nick(s) on channel.

/_voice <#channel> <nick1> [nick2,nickN..,nick25] Voice nick(s) on channel.

/_devoice <#channel> <nick1> [nick2,nickN..,nick25] Devoice nick(s) on channel.

/_ns <parammeter> send's raw command to server with NickServ as target

/_cs <parammeter> send's raw command to server with ChanServ as target
 The parammter $2 is also a channel so you don't need to specify the # caracter.
  E.g. /_cs identify PST i-don't-know-the-password-hehe

/_ms <parammeter> send's raw command to server with MemoServ as target

/_os <parammeter> send's raw command to server with OperServ as target if o isin usermode.

/_newss <parammeter> send's raw command to server with NewsServ as target only on PTlink.

/_allnicks <#channel> [parammeters] make a command for all nicks on #channel.
 E.g.
  /_allnicks #PST echo -a will echo all nicks on #PST
  /_allnicks #PST mode #PST +o will op all nicks on #PST

/_id Just open a password box to identify on NickServ /_ns command used

/_cycleall Just cycle all channels

/_diaop [type-of-dialog] <name> Just open a closed dialog if type is null the type will be -m
 E.g. 
  /_diaop lol 
  /_diaop -md lol

/_mdid <dname> <type> <first-id> [second-id] Make a multiple did of first-id to second-id.
 E.g.
  /_mdid lol -h 5 15 Will hide all id's between 5 and 15 on dialog 15
  /_mdid lol -a 1 3 I will print this on id 1, 2 and 3

/_fdcc [on|off] If 'on' turns Dcc packetsize to 8192, fsend and Pdcc to on or to off if 'off' and packet
 size to 4096. If no parammeter will print the info about this 3 types.

/_sockopen <parammeters> Just op a 'closed' socket on host and port.

/_sockaccept <name> accepts a sockconnection to a 'closed' socket.

/_sockrename <name> <newname> If name is in use and newname is not will rename the sock 
 name.

/_socklisten <name> <port> If name is not in use and port is free will listen for connection.

/_sockclose <name> If name is in use will close the connection.

/_run <file> Will run a file in $shortfn format.

/_modeall [-kick|-kb] [<parammeter>] will change mode for all channels or common channels or Kick
 or kickban.
  E.g.
   /_modeall -kick CoolMaster Bye will kick CoolMaster from all Common channels where you are op.
   /_modeall -kb CoolMaster will kick/ban CoolMaster from all Common channels where you are op.
   /_modeall +ik lol will mode all channels where you are op with +i mode and +k where key is lol

/_font -scq <font size> <font name> change the font of mIRC windows 
 (the fonts aren't lost next time you open mIRC)
  -s is to change status' window font
  -q is for all query windows
  -c is to change chan's windows fonts

/_lnsp <-dehiNtsaqlbfnm / #chan / [=]Nick> echo a line separator (with nothin' written)

/_splay <file> Will splay file with $shortfn format. If extension is mp3 will splay
 with -p, if is mid will splay with -m, if is wav will splay with -w, else withou any parammeters.

/_closeall Close all mIRC windows.

/_closechat [nick1 nickN] If you specify nick will close all nicks matched else will close all
 chat windows.
 
/_closefserv [nick1 nickN] If you specify nick will close all nicks matched else will close all
 fserv windows.

/_closequery [nick1 nickN] If you specify nick will close all nicks matched else will close all
 query windows.

/_closeget [nick1 nickN] If you specify nick will close all nicks matched else will close all
 get windows.

/_closeinactive [nick1 nickN] If you specify nick will close all nicks matched else will close all
 dcc inactive windows.

/_closesend [nick1 nickN] If you specify nick will close all nicks matched else will close all
 send windows.

/_close@ [nick1 nickN] If you specify nick will close all nicks matched else will close all
 custom @windows.

/_joininvite Join to last invited #channel.

/_nicklist <#channel> <colour-ops> <colour-voices> <colour-yournick> will
 cline #channel nicklist with colours.

/_statusers <#channel> will echo all #channel users stats with percent of ops and voices.


Hash Tables like %variables.

Note: <needed> [optional]


This section have several commands that makes it easier to work with hash tables
better yet... you can use these comands to work with hash tables like you would with %vars


/_set <var-name> <var-value> Set var with value.
 E.g. /_set nick CoolMaster

/_inc <var-name> [N] Increments one unitity if N is null else increment N.
 E.g.
  /_inc start
  /_inc start 2

/_dec <var-name> [N] Just like /_inc but here decrement.
 E.g.
  /_dec start
  /_dec start 2

$_get(var-name) return value of var-name.
 E.g. //echo -a $_get(CoolMaster) and if CoolMaster exists will return value of CoolMaster.

/_unset [-w] <var-name> Unset var name. Use -w to unset wildcards.
 E.g. 
  /_unset CoolMaster 
  /_unset C*r

/_make <size> Just creates an hash table with HV.VARS table with size, recommend use
 1000 on size. This command is to use on on start event

/_unsetall hfree table of HV.VARS

/_hv.hsave This save all table to a file. This command is to use on exit event.

/_hv.load Loads a table data from HV.VARS need to use this command after /_make on on start.


If you pretend to use this hash tables like variables you need to put this in your remotes:

on *:start:_make 1000 | _hv.load
on *:exit:_hv.save


New


$_file(filename) returns some props of filename
 Props:(ex: $_file($mircexe).created)
  created return time when file was created
  modified return time when file was modified
  access return time when file was access
  size return the size of file


$_e(parammeters,tokens) Echos some text with parammenters Ex: $_e(-s,Welcome to mIRC Scripting Library)


/mp3list directory txt|htm Create mp3 list on .txt or html format. Ex: /mp3list c:\mp3 htm








HTML by CoolMaster